程序员交接文档格式(自己整理，仅供参考，付md文档)

交付人各项目详细

一、XXX项目

标题：	内容
完成情况:	**************************************************************
涉及数据库：	**************************************************************
需求文档地址：	**************************************************************
详细设计文档地址：	**************************************************************
其他文档地址：	**************************************************************
……

1.1 前端

• 界面展示（必填）
  • 以截图形式/视频形式说明该功能的展示界面。
• 前端架构
  • 包括页面间的交互关系，以及是否引入外部插件等
• 源码位置（必填）
  • …/aaaaa/aaaaa/aaaaa.git
• 业务流程图
  • 如果该模块涉及到流程图的转换，请以流程图的形式表述系统中状态的转换。
• 线上地址（必填）
  • 192.168.0.*/vue/temp
• 调用的外部域名（必填）
  • www.****.com(内部连调端口号)
  • www.****.com(内部连调端口号)
  • www.****.com (内部连调端口号)
• 开发进度（必填）
  • 尚未开发
  • 开发过程中
  • 开发基本完成，但有Bug未完成
  • 开发全部完成
• 补充备注（存在隐患、后期接手人需要注意点、建议修改点）（必填）
  • ……………………………………………………………………

1.2 XXX模块后端

• 后端架构
  • 以时序图形式展示不同业务层次间的调用关系
• 源码位置（必填）
  • …/aaaaa/aaaaa/aaaaa.java
• 线上服务器地址（必填）
  • 101.11.11.11……
• 关联数据库（必填）
  • MySQL：111.111.111.11:3306
  • Redis：……
  • ElasticSearch：……
  • MangoDB：……
• 开发进度（必填）
  • 尚未开发
  • 开发过程中
  • 开发基本完成，但有Bug未完成
  • 开发全部完成
• 补充备注（存在隐患、后期接手人需要注意点、建议修改点）（必填）
  • ……………………………………………………………………

二、XXX项目

2.1 前端
……………………………………………………………………

2.2 XXX模块后端
……………………………………………………………………

---

附：md文档

# 交付人各项目详细
# 一、XXX项目
| 标题：       | 内容     |
| :--------- | :--------------------------------------: | 
| 完成情况:     |  **************************************************************  |  
| 涉及数据库：   |   **************************************************************  |   
| 需求文档地址：  |   **************************************************************  | 
| 详细设计文档地址：  |   **************************************************************  | 
| 其他文档地址：  |   **************************************************************  | 
……

1.1 前端
-  界面展示（必填）
	-  以截图形式/视频形式说明该功能的展示界面。
-  前端架构
	-  包括页面间的交互关系，以及是否引入外部插件等
-  源码位置（必填）
	-  ../aaaaa/aaaaa/aaaaa.js
-  业务流程图
	-  如果该模块涉及到流程图的转换，请以流程图的形式表述系统中状态的转换。
- 线上地址（必填）
	- 192.168.0.*/vue/temp 
- 调用的外部域名（必填）
	- www.****.com(内部连调端口号)
	- www.****.com(内部连调端口号)
	- www.****.com (内部连调端口号)
-  开发进度（必填）
	-  尚未开发
	-  开发过程中
	-  开发基本完成，但有Bug未完成
	-  开发全部完成
- 补充备注（存在隐患、后期接手人需要注意点、建议修改点）（必填）
	- ……………………………………………………………………

1.2 XXX模块后端
-  后端架构
	-  以时序图形式展示不同业务层次间的调用关系
-  源码位置（必填）
	-  ../aaaaa/aaaaa/aaaaa.java
- 线上服务器地址（必填）
	- 101.11.11.11……
-  关联数据库（必填）
	- MySQL：111.111.111.11:3306
	- Redis：……
	- ElasticSearch：……
	- MangoDB：……
-  开发进度（必填）
	-  尚未开发
	-  开发过程中
	-  开发基本完成，但有Bug未完成
	-  开发全部完成
- 补充备注（存在隐患、后期接手人需要注意点、建议修改点）（必填）
	- ……………………………………………………………………
# 二、XXX项目
2.1 前端
……………………………………………………………………

2.2 XXX模块后端
 ……………………………………………………………………